Skip to main content

Application Management

supOS supports service routing based on Konga, and you can add your application to supOS for integrated entry. Following certain rules, you can:

  • Set the routing path to your backend service.
  • Fashion access authorization mechanisms.
  • Add external service to supOS frontend as one of the applications.

Creating Service​

  1. Select System > RoutingManagement, and then click SERVICES.
tip

If the DASHBOARD shows no active connection, go to CONNECTIONS, and then click ACTIVATE next to Kong.

  1. Click ADD NEW SERVICE, and then enter the information of your backend service.
info

These parameters are necessary. For instance, you have a backend resource https://example.com:8080.

  • Protocol: https
  • Host: example.com
  • Port: 8080
  • Path: Request path prefix, which will added to the path of request from client before the request gets forwarded to your service.
  1. Click SUBMIT SERVICE.

Buiding Routes​

Build the routing path for accessing the service.

  1. On the Service Details page, click Routes.
  2. Click ADD ROUTE, and then enter the information of the route to access your service.
  • Tags: We have mapped some tags with fixed meanings.
TagDescription
menuThe service will appear as an application on supOS homepage.
parentName:menu.tag.xxxxxx is the name of an existing first-level menu in supOS (all in lowercase). It indicates that the current route appears as a second-level menu of xxx.
homeParentName:menu.tag.xxxxxx is the name of an existing first-level menu in supOS (all in lowercase). It indicates that the current route appears in the navigation bar and serves as a second-level menu of xxx.
description:menu.desc.xxxxxx is the name of the route. It represents the description information corresponding to xxx.
  • Paths: Request paths that will be recognized by Kong and Kong will match and forward the request to your service.
  1. Click SUBMIT ROUTE.

Setting Authentication​

Set authentication mechanisms for your service.

  1. On the Service Details page, click Plugins.
  2. Click ADD PLUGIN, and select Key Auth.
note

You can add other authentication methods. For more details, see Konga.

  1. Enter the Key names and decide how the anthentication information should be transmitted.
  1. Click ADD PLUGIN.
  2. Click CONSUMERS on the left side menu to add an authentication key.
    1. Click CREATE CONSUMER, and give it a username or ID.
    2. On the details page, select Credentials.
    3. Select API KEYS, and then create an API key.
    4. Leave it empty and click SUBMIT, Konga will generate a custom key, which is necessary when accessing your service.